package events;

/**
 * Generate_Travelers is a class that inheirts the event class. This allows for
 * further definition of the unique objects that occur only within the
 * Generate_Travelers event. When this event is processed, the simulation will
 * be given an integer value representing the total number of additional
 * travelers that need to be added into the Simulation.
 * 
 * @author Team Switchboard Boxcar
 * 
 */
public class Generate_Travelers extends Event {

	private int numAddlTravelers; // Number of travelers to generate

	/**
	 * The Generate_Travelers Constructor builds the GenerateTravelers event.
	 * 
	 * @param addlTravelers
	 *            The number of additional Travelers that need to be generated
	 *            when this event is processed.
	 * @param time
	 *            The time that travelers should be added into the Simulation.
	 */
	public Generate_Travelers(int addlTravelers, int time) 
	{
		super(3, time);
		numAddlTravelers = addlTravelers;
	}
	
	/**
	 * AddTravelers returns the total number of travelers that need to be added
	 * into the simulation by this event.
	 * 
	 * @return Returns an integer representing the total number of travelers and
	 *         cars that need to be created.
	 */
	public int AddTravelers()
	{return numAddlTravelers;}
}